Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: export performance data #54412

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
Open

feat: export performance data #54412

wants to merge 9 commits into from
+246 −245

Conversation

adhorodyski
Copy link
Contributor

@adhorodyski adhorodyski commented Dec 20, 2024 •
edited
Loading

@mountiny @hannojg

Explanation of Change

This PR adds support for exporting performance measures collected during a profiling session with the Use Profiling debug feature. They are added to the AppInfo file under the performance property.

I've attached a recording from web with additional debug logs to visualize what gets fired when we enable the profiler now.

Fixed Issues

$ #50652
PROPOSAL: N/A

Tests

Same as the QA steps.

  • Verify that no errors appear in the JS console

Offline tests

Same as the QA steps.

QA Steps

  1. Open the Expensify app.
  2. Follow the README steps for recording a profile trace: https://github.com/Expensify/App?tab=readme-ov-file#recording-a-trace - I recommend visiting chats to capture a few open_report* entries.
  3. Download the resulting AppInfo<app version>.json file. This should now include a performance property on it. It's an array of measures collected during the profiling session. They should reflect actions successfully collected with the Performance.markStart/End() API.

PR Author Checklist

  • I linked the correct issue in the ### Fixed Issues section above
  • I wrote clear testing steps that cover the changes made in this PR
    • I added steps for local testing in the Tests section
    • I added steps for the expected offline behavior in the Offline steps section
    • I added steps for Staging and/or Production testing in the QA steps section
    • I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    • I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
    • I tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
  • I included screenshots or videos for tests on all platforms
  • I ran the tests on all platforms & verified they passed on:
    • Android: Native
    • Android: mWeb Chrome
    • iOS: Native
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
    • MacOS: Desktop
  • I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
  • I followed proper code patterns (see Reviewing the code)
    • I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick)
    • I verified that comments were added to code that is not self explanatory
    • I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
    • I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
      • If any non-english text was added/modified, I used JaimeGPT to get English > Spanish translation. I then posted it in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
    • I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
    • I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
    • I verified the JSDocs style guidelines (in STYLE.md) were followed
  • If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • I followed the guidelines as stated in the Review Guidelines
  • I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
  • I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • I verified any variables that can be defined as constants (ie. in CONST.ts or at the top of the file that uses the constant) are defined as such
  • I verified that if a function's arguments changed that all usages have also been updated correctly
  • If any new file was added I verified that:
    • The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
  • If a new CSS style is added I verified that:
    • A similar style doesn't already exist
    • The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))
  • If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
  • If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
  • If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
  • If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
  • If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design so the design team can review the changes.
  • If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
  • I added unit tests for any new feature or bug fix in this PR to help automatically prevent regressions in this user flow.
  • If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.

Screenshots/Videos

Android: Native
Android: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari
devtools.mp4
MacOS: Desktop

@adhorodyski adhorodyski mentioned this pull request Dec 20, 2024
Open
@mountiny mountiny self-requested a review December 23, 2024 12:44
@adhorodyski adhorodyski force-pushed the feat/export-perf-metrics branch from b1924cb to 64a637a Compare December 27, 2024 17:01
@adhorodyski
Copy link
Contributor Author

adhorodyski commented Dec 27, 2024 •
edited
Loading

cc @mountiny @hannojg I'm testing this now further, but for a TLDR I reworked how the whole Performance module is being declared.

I figured why its' init has been postponed until invoked (dynamic require) and moved the possible 'heavy' workload into opt-in calls - the dependency module (react-native-performance) is now always there, but does ~nothing until invoked because all the observers are turned off by default.
On a side note, it's also way more approachable now I think to edit & in line with the code guidelines.

This enables us to:

  • turn it on/off with the profiler on demand
  • still have it turned on from the start based on the CAPTURE_METRICS env variable

If any part of the profiling turns to be too heavy during runtime measurements, we can turn turn it off and stick to the debug workflows (eg. for resource logging).

@adhorodyski
Copy link
Contributor Author

Also moved the BaseProfilingToolMenu component to useOnyx as it only had a single prop provided through withOnyx.

@mountiny
Copy link
Contributor

@rayane-djouah can you please test and review this PR?

@adhorodyski, can you please add testing steps to make sure everything related to performance monitoring works as expected after this change?

@adhorodyski
Copy link
Contributor Author

Yes, I will update these in a few hours. I tested this on web + mobile ios (works fine), will also run on mobile android.
There's one problem I had to workaround locally which is already known, the release profiler currently errors out on Hermes, we decided to leave it 'as is' until we merge the RN upgrade. cc @hannojg

@adhorodyski adhorodyski marked this pull request as ready for review December 30, 2024 15:15
@adhorodyski adhorodyski requested a review from a team as a code owner December 30, 2024 15:15
@melvin-bot melvin-bot bot requested review from tgolen and removed request for a team December 30, 2024 15:15
@melvin-bot Melvin Bot
Copy link

melvin-bot bot commented Dec 30, 2024

@tgolen Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

@adhorodyski
Copy link
Contributor Author

@hannojg / @kirillzyusko can I ask you to help verify if the e2e tests pass fine for you with these updates? Changes included here should be transparent and non-breaking :)

@adhorodyski
Copy link
Contributor Author

adhorodyski commented Dec 30, 2024 •
edited
Loading

@mountiny I'm still fighting with Android builds today to verify on this platform. I'll update when done. Please let me know if there's anything else missing on my end.

tgolen
tgolen requested changes Dec 30, 2024
View reviewed changes
src/libs/Performance.tsx Outdated Show resolved Hide resolved
src/libs/Performance.tsx Outdated Show resolved Hide resolved
src/libs/Performance.tsx Outdated Show resolved Hide resolved
tests/e2e/ADDING_TESTS.md Outdated Show resolved Hide resolved
tests/e2e/ADDING_TESTS.md Show resolved Hide resolved
@adhorodyski adhorodyski force-pushed the feat/export-perf-metrics branch from 4fa0b75 to 48e5d1b Compare December 30, 2024 15:53
@adhorodyski
Copy link
Contributor Author

@tgolen addressed all the comments, thanks!

tgolen
tgolen previously approved these changes Dec 30, 2024
View reviewed changes
@tgolen
Copy link
Contributor

tgolen commented Dec 30, 2024

Ready for @rayane-djouah to review and test.

@adhorodyski
Copy link
Contributor Author

adhorodyski commented Dec 31, 2024 •
edited
Loading

Managed to finally run on Android, spotted one bug that prints the TTI metric under measureTTI on regular builds without checking for the CAPTURE_METRICS env variable - fixing this now.

Edit: all good across the platforms cc @mountiny

@rayane-djouah
Copy link
Contributor

rayane-djouah commented Jan 2, 2025 •
edited
Loading

I run npm run build for the web to get source map, launched the dev build, and tested profiling. I received the two files as expected, with the performance measures in the array.

However, npm run ios-build is not completing successfully for me. @adhorodyski, do you have any idea why this might be happening?

Additionally, I tried starting profiling in a dev build on iOS native, and the app crashed. Could this be due to the absence of a source map?

@adhorodyski, if possible, could you clarify the test steps further? Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tgolen tgolen tgolen approved these changes

@mountiny mountiny Awaiting requested review from mountiny

@rayane-djouah rayane-djouah Awaiting requested review from rayane-djouah

Assignees

@adhorodyski adhorodyski

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@adhorodyski @mountiny @tgolen @rayane-djouah